docs: trim core architecture guides and diagrams - #606
Merged
Conversation
Rewrite docs 00-04 and the diagram captions as terse descriptions of the current contract, cutting rationale essays, grant-milestone and platform-target planning material, and 0.3 version promises reduced to current fact. Verify every retained claim against crates/nexum-runtime: engine.toml [limits] keys and defaults (fuel 1B, memory 64 MiB, state 50 MiB, deadline 120s), the six-primitive event-module world, and the single-file keccak256-prefixed local store (ADR-0003). Correct substantive drift: module discovery is filesystem-only in 0.2 with ENS and registry as design direction; the shepherd:cow package now carries only cow-events and order submission is the videre:venue venue-adapter contract; the local store commits per host call rather than per event. Part of #598.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Trim the core architecture guides (docs 00-04) and the diagram caption files to terse descriptions of the current contract, per the #598 house standard: cut rationale essays, grant-milestone and platform-target planning material, before/after narrative, and duplicated primitive-by-primitive prose. 0.3 version promises are reduced to current fact. Net ~770 lines removed.
Why
These are the canonical what-is-true-now guides and had drifted: they carried planning prose the rubric bans, stale crate/interface vocabulary, and several claims the current code no longer backs. Owner boundaries restored: 05 owns the SDK, 08 owns the venue layer and platform model; the core guides link them rather than duplicating.
Testing
Documentation-only, pure markdown: no build required. Verified every retained claim against
crates/nexum-runtime(engine_config.rslimit keys/defaults,wit/nexum-hostworld imports,host/local_store_redb.rsnamespacing and transaction model), confirmed no em dashes, confirmed no cross-doc links point at removed anchors.AI Assistance
Documentation-only sweep; claims verified against the runtime source, and the markdown link graph checked for dangling references.
Deviations flagged
crates/nexum-runtime/src/host/local_store_redb.rs(get/set/delete) opens and commits its own redb transaction per call, andhost/impls/local_store.rscalls straight through with no supervisor-level wrapping, so a trap mid-event keeps already-committed writes. Docs corrected to per-call committed durability; the missing atomic-rollback guarantee is flagged here rather than papered over.keccak256(module_name)key prefix per ADR-0003 (local_store_redb.rs). Corrected in the docs.shepherd:cow/cow-apiand ashepherdworld as the shipped CoW contract. In the treewit/shepherd-cowcarries onlycow-events, there is nocow-apihost interface orOrderBookPool, and order submission is thevidere:venuevenue-adapter contract (wit/videre-venue,crates/cow-venue,crates/videre-sdk). Prose corrected to the venue model with a doc-08 pointer; the rendered diagram sources underdocs/diagrams/*.mmd/*.pngstill show the old cow-api path and are marked historical pending regeneration (out of scope for a docs sweep).